<!DOCTYPE html><html><head>
<title>processman - processman</title>
<style type="text/css"><!--
    HTML {
	background: 	#FFFFFF;
	color: 		black;
    }
    BODY {
	background: 	#FFFFFF;
	color:	 	black;
    }
    DIV.doctools {
	margin-left:	10%;
	margin-right:	10%;
    }
    DIV.doctools H1,DIV.doctools H2 {
	margin-left:	-5%;
    }
    H1, H2, H3, H4 {
	margin-top: 	1em;
	font-family:	sans-serif;
	font-size:	large;
	color:		#005A9C;
	background: 	transparent;
	text-align:		left;
    }
    H1.doctools_title {
	text-align: center;
    }
    UL,OL {
	margin-right: 0em;
	margin-top: 3pt;
	margin-bottom: 3pt;
    }
    UL LI {
	list-style: disc;
    }
    OL LI {
	list-style: decimal;
    }
    DT {
	padding-top: 	1ex;
    }
    UL.doctools_toc,UL.doctools_toc UL, UL.doctools_toc UL UL {
	font:		normal 12pt/14pt sans-serif;
	list-style:	none;
    }
    LI.doctools_section, LI.doctools_subsection {
	list-style: 	none;
	margin-left: 	0em;
	text-indent:	0em;
	padding: 	0em;
    }
    PRE {
	display: 	block;
	font-family:	monospace;
	white-space:	pre;
	margin:		0%;
	padding-top:	0.5ex;
	padding-bottom:	0.5ex;
	padding-left:	1ex;
	padding-right:	1ex;
	width:		100%;
    }
    PRE.doctools_example {
	color: 		black;
	background: 	#f5dcb3;
	border:		1px solid black;
    }
    UL.doctools_requirements LI, UL.doctools_syntax LI {
	list-style: 	none;
	margin-left: 	0em;
	text-indent:	0em;
	padding:	0em;
    }
    DIV.doctools_synopsis {
	color: 		black;
	background: 	#80ffff;
	border:		1px solid black;
	font-family:	serif;
	margin-top: 	1em;
	margin-bottom: 	1em;
    }
    UL.doctools_syntax {
	margin-top: 	1em;
	border-top:	1px solid black;
    }
    UL.doctools_requirements {
	margin-bottom: 	1em;
	border-bottom:	1px solid black;
    }
--></style>
</head>
<!-- Generated from file 'processman.man' by tcllib/doctools with format 'html'
   -->
<!-- Copyright &amp;copy; 2015 Sean Woods &amp;lt;yoda@etoyoc.com&amp;gt;
   -->
<!-- processman.n
   -->
<body><hr> [
   <a href="../../../../../../../../home">Tcllib Home</a>
&#124; <a href="../../../../toc.html">Main Table Of Contents</a>
&#124; <a href="../../../toc.html">Table Of Contents</a>
&#124; <a href="../../../../index.html">Keyword Index</a>
&#124; <a href="../../../../toc0.html">Categories</a>
&#124; <a href="../../../../toc1.html">Modules</a>
&#124; <a href="../../../../toc2.html">Applications</a>
 ] <hr>
<div class="doctools">
<h1 class="doctools_title">processman(n) 0.1 tcllib &quot;processman&quot;</h1>
<div id="name" class="doctools_section"><h2><a name="name">Name</a></h2>
<p>processman - Tool for automating the period callback of commands</p>
</div>
<div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2>
<ul class="doctools_toc">
<li class="doctools_section"><a href="#toc">Table Of Contents</a></li>
<li class="doctools_section"><a href="#synopsis">Synopsis</a></li>
<li class="doctools_section"><a href="#section1">Description</a></li>
<li class="doctools_section"><a href="#section2">Commands</a></li>
<li class="doctools_section"><a href="#section3">Bugs, Ideas, Feedback</a></li>
<li class="doctools_section"><a href="#keywords">Keywords</a></li>
<li class="doctools_section"><a href="#category">Category</a></li>
<li class="doctools_section"><a href="#copyright">Copyright</a></li>
</ul>
</div>
<div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2>
<div class="doctools_synopsis">
<ul class="doctools_requirements">
<li>package require <b class="pkgname">Tcl 8.5</b></li>
<li>package require <b class="pkgname">twapi 3.1</b></li>
<li>package require <b class="pkgname">cron 1.1</b></li>
<li>package require <b class="pkgname">processman <span class="opt">?0.1?</span></b></li>
</ul>
<ul class="doctools_syntax">
<li><a href="#1"><b class="cmd">::processman::find_exe</b> <i class="arg">name</i></a></li>
<li><a href="#2"><b class="cmd">::processman::kill</b> <i class="arg">id</i></a></li>
<li><a href="#3"><b class="cmd">::processman::kill_all</b></a></li>
<li><a href="#4"><b class="cmd">::processman::killexe</b> <i class="arg">name</i></a></li>
<li><a href="#5"><b class="cmd">::processman::onexit</b> <i class="arg">id</i> <i class="arg">cmd</i></a></li>
<li><a href="#6"><b class="cmd">::processman::priority</b> <i class="arg">id</i> <i class="arg">level</i></a></li>
<li><a href="#7"><b class="cmd">::processman::process_list</b></a></li>
<li><a href="#8"><b class="cmd">::processman::process_list</b> <i class="arg">id</i></a></li>
<li><a href="#9"><b class="cmd">::processman::spawn</b> <i class="arg">id</i> <i class="arg">cmd</i> <i class="arg">args</i></a></li>
</ul>
</div>
</div>
<div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2>
<p>The <b class="package">processman</b> package provides a Pure-tcl set of utilities
to manage child processes in a platform-generic nature.</p>
</div>
<div id="section2" class="doctools_section"><h2><a name="section2">Commands</a></h2>
<dl class="doctools_definitions">
<dt><a name="1"><b class="cmd">::processman::find_exe</b> <i class="arg">name</i></a></dt>
<dd><p>Locate an executable by the name of <i class="arg">name</i> in the system path. On windows,
also add the .exe extention if not given.</p></dd>
<dt><a name="2"><b class="cmd">::processman::kill</b> <i class="arg">id</i></a></dt>
<dd><p>Kill a child process <i class="arg">id</i>.</p></dd>
<dt><a name="3"><b class="cmd">::processman::kill_all</b></a></dt>
<dd><p>Kill all processes spawned by this program</p></dd>
<dt><a name="4"><b class="cmd">::processman::killexe</b> <i class="arg">name</i></a></dt>
<dd><p>Kill a process identified by the executable. On Unix, this triggers a killall.
On windows, <b class="cmd">twapi::get_process_ids</b> is used to map a name one or more IDs,
which are then killed.</p></dd>
<dt><a name="5"><b class="cmd">::processman::onexit</b> <i class="arg">id</i> <i class="arg">cmd</i></a></dt>
<dd><p>Arrange to execute the script <i class="arg">cmd</i> when this programe detects that
process <i class="arg">id</i> as terminated.</p></dd>
<dt><a name="6"><b class="cmd">::processman::priority</b> <i class="arg">id</i> <i class="arg">level</i></a></dt>
<dd><p>Mark process <i class="arg">id</i> with the priorty <i class="arg">level</i>. Valid levels: low, high, default.</p>
<p>On Unix, the process is tagged using the <b class="cmd">nice</b> command.</p>
<p>On Windows, the process is modifed via the <b class="cmd">twapi::set_priority_class</b></p></dd>
<dt><a name="7"><b class="cmd">::processman::process_list</b></a></dt>
<dd><p>Return a list of processes that have been triggered by this program, as
well as a boolean flag to indicate if the process is still running.</p></dd>
<dt><a name="8"><b class="cmd">::processman::process_list</b> <i class="arg">id</i></a></dt>
<dd><p>Return true if process <i class="arg">id</i> is still running, false otherwise.</p></dd>
<dt><a name="9"><b class="cmd">::processman::spawn</b> <i class="arg">id</i> <i class="arg">cmd</i> <i class="arg">args</i></a></dt>
<dd><p>Start a child process, identified by <i class="arg">id</i>. <i class="arg">cmd</i> is the name
of the command to execute. <i class="arg">args</i> are arguments to pass to that command.</p></dd>
</dl>
</div>
<div id="section3" class="doctools_section"><h2><a name="section3">Bugs, Ideas, Feedback</a></h2>
<p>This document, and the package it describes, will undoubtedly contain
bugs and other problems.
Please report such in the category <em>odie</em> of the
<a href="http://core.tcl.tk/tcllib/reportlist">Tcllib Trackers</a>.
Please also report any ideas for enhancements you may have for either
package and/or documentation.</p>
<p>When proposing code changes, please provide <em>unified diffs</em>,
i.e the output of <b class="const">diff -u</b>.</p>
<p>Note further that <em>attachments</em> are strongly preferred over
inlined patches. Attachments can be made by going to the <b class="const">Edit</b>
form of the ticket immediately after its creation, and then using the
left-most button in the secondary navigation bar.</p>
</div>
<div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2>
<p><a href="../../../../index.html#odie">odie</a>, <a href="../../../../index.html#processman">processman</a></p>
</div>
<div id="category" class="doctools_section"><h2><a name="category">Category</a></h2>
<p>System</p>
</div>
<div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2>
<p>Copyright &copy; 2015 Sean Woods &lt;yoda@etoyoc.com&gt;</p>
</div>
</div></body></html>
